post /vms/{vmId}/operations/reconfigure

Reconfigure VM(reconfigureVm)

When a VM is running in cloud, its settings can be changed. You can change the AWS/Azure/Gcp instance type (for example, select an instance that performs better for this workload, or an instance that costs less, and so on) and the security groups it is assigned to. When changing the instance type, a reboot is required, however the instance Private IP address and other identifiers remain the same. You can also reconfigure the storage policy from Write Back to Write Isolation, and vice-versa. All virtual machine state and data created in cloud in write-isolation mode will be lost when machines are moved back on-premises. Related virtual machines, which are part of the same application, should be moved together to align application state. Make sure to copy out to a persistent location any data you wish to keep prior to moving such machines back to on-premises. A typical scenario for changing the storage from Write Isolation to Write Back is for a Dev-Test environment or a project that is nearing an end. By changing the VM to run from Write Isolation to Write Back, the data is written back to on-premises. Once the data is backed up, you can then run the VM back on-premises. When switching from Write Back to Write Isolation, the edge node stops transferring the data from the cloud instance. This may result in an inconsistent snapshot.

Path parameters

vmId (required)

Path Parameter — Virtual machine ID

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

reconfigureSpec ReconfigureVmRequest (required)

instanceType (optional)

String VM new instance type

storagePolicy (optional)

StoragePolicy

Storage policy - write back or write isolation.

_type

String Whether to run the VM in AWS or Azure.

Enum:

AwsReconfigureVmRequest

AzureReconfigureVmRequest

GcpReconfigureVmRequest

 

Body Parameter — Reconfigure Specifications

Return type

TaskId

value (optional)

String Entity ID

_type

String Task ID

Enum:

TaskId

 

Example data

Content-Type: application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

201

Created TaskId

Default

Error ErrorInfo

errorCode (optional)

String

url(optional)

String

message (optional)

String